ltecat18.h File Reference

This file contains API for LTE Cat.1 8 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	ltecat18_t
	LTE Cat.1 8 Click context object. More...
struct	ltecat18_cfg_t
	LTE Cat.1 8 Click configuration object. More...

Macros
#define	LTECAT18_CMD_AT   "AT"
	LTE Cat.1 8 control commands.
#define	LTECAT18_CMD_GET_MODEL_ID   "AT+CGMM"
#define	LTECAT18_CMD_GET_SW_VERSION   "AT+CGMR"
#define	LTECAT18_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define	LTECAT18_CMD_FACTORY_RESET   "AT&F"
#define	LTECAT18_CMD_SET_PHONE_FUNCTIONALITY   "AT+CFUN"
#define	LTECAT18_CMD_NETWORK_REGISTRATION   "AT+CREG"
#define	LTECAT18_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define	LTECAT18_CMD_OPERATOR_SELECTION   "AT+COPS"
#define	LTECAT18_CMD_SEND_SMS   "AT+CMGS"
#define	LTECAT18_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define	LTECAT18_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define	LTECAT18_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define	LTECAT18_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define	LTECAT18_CMD_START_TCPIP_SERVICE   "AT+NETOPEN"
#define	LTECAT18_CMD_OPEN_TCP_UDP_CONNECTION   "AT+CIPOPEN"
#define	LTECAT18_CMD_SEND_DATA_VIA_CONNECTION   "AT+CIPSEND"
#define	LTECAT18_CMD_RECEIVE_DATA_VIA_CONNECTION   "AT+CIPRXGET"
#define	LTECAT18_CMD_CLOSE_TCP_UDP_CONNECTION   "AT+CIPCLOSE"
#define	LTECAT18_RSP_OK   "OK"
	LTE Cat.1 8 device response for AT commands.
#define	LTECAT18_RSP_ERROR   "ERROR"
#define	LTECAT18_URC_RECEIVED_DATA   "+CIPRXGET:"
	LTE Cat.1 8 device unsolicited response code (URC) settings.
#define	LTECAT18_URC_CONNECTION_OPEN   "+CIPOPEN:"
#define	LTECAT18_URC_CONNECTION_CLOSED   "+CIPCLOSE:"
#define	LTECAT18_POWER_STATE_OFF   0
	LTE Cat.1 8 power state settings.
#define	LTECAT18_POWER_STATE_ON   1
#define	LTECAT18_POWER_STATE_RESET   2
#define	LTECAT18_TX_DRV_BUFFER_SIZE   256
	LTE Cat.1 8 driver buffer size.
#define	LTECAT18_RX_DRV_BUFFER_SIZE   256
#define	LTECAT18_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ltecat18_return_value_t { LTECAT18_OK = 0 , LTECAT18_ERROR = -1 , LTECAT18_ERROR_TIMEOUT = -2 , LTECAT18_ERROR_CMD = -3 }
	LTE Cat.1 8 Click return value data. More...

Functions
void	ltecat18_cfg_setup (ltecat18_cfg_t *cfg)
	LTE Cat.1 8 configuration object setup function.
err_t	ltecat18_init (ltecat18_t *ctx, ltecat18_cfg_t *cfg)
	LTE Cat.1 8 initialization function.
err_t	ltecat18_generic_write (ltecat18_t *ctx, uint8_t *data_in, uint16_t len)
	LTE Cat.1 8 data writing function.
err_t	ltecat18_generic_read (ltecat18_t *ctx, uint8_t *data_out, uint16_t len)
	LTE Cat.1 8 data reading function.
void	ltecat18_set_pwr_pin (ltecat18_t *ctx, uint8_t state)
	LTE Cat.1 8 set PWR pin function.
void	ltecat18_set_rst_pin (ltecat18_t *ctx, uint8_t state)
	LTE Cat.1 8 set RST pin function.
void	ltecat18_set_rts_pin (ltecat18_t *ctx, uint8_t state)
	LTE Cat.1 8 set RTS pin function.
uint8_t	ltecat18_get_ring_pin (ltecat18_t *ctx)
	LTE Cat.1 8 get RING pin function.
uint8_t	ltecat18_get_cts_pin (ltecat18_t *ctx)
	LTE Cat.1 8 get CTS pin function.
void	ltecat18_set_power_state (ltecat18_t *ctx, uint8_t state)
	LTE Cat.1 8 set power state function.
void	ltecat18_cmd_run (ltecat18_t *ctx, uint8_t *cmd)
	LTE Cat.1 8 cmd run function.
void	ltecat18_cmd_set (ltecat18_t *ctx, uint8_t *cmd, uint8_t *value)
	LTE Cat.1 8 cmd set function.
void	ltecat18_cmd_get (ltecat18_t *ctx, uint8_t *cmd)
	LTE Cat.1 8 cmd get function.
void	ltecat18_cmd_help (ltecat18_t *ctx, uint8_t *cmd)
	LTE Cat.1 8 cmd help function.
void	ltecat18_set_sim_apn (ltecat18_t *ctx, uint8_t *sim_apn)
	Set sim card APN.
void	ltecat18_send_sms_text (ltecat18_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.1 8 send SMS in text mode.
err_t	ltecat18_send_sms_pdu (ltecat18_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.1 8 send SMS in PDU mode.

Detailed Description

This file contains API for LTE Cat.1 8 Click Driver.

Enumeration Type Documentation

ltecat18_return_value_t

enum ltecat18_return_value_t

LTE Cat.1 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT18_OK
LTECAT18_ERROR
LTECAT18_ERROR_TIMEOUT
LTECAT18_ERROR_CMD